socketTimeoutInterval

Type

property

Summary

Specifies how long to wait for a read from socket or write to socket command to finish before timing out.

Syntax

set the socketTimeoutInterval to <milliseconds>

Description

Use the socketTimeoutInterval to specify a time to wait for socket actions to complete.

If the socketTimeoutInterval passes and no data has been transmitted yet, the socketTimeout message is sent to the object whose script contains the read from socket or write to socket command.

LiveCode checks the socketTimeoutInterval every time a read from socket or write to socket command is executed, so you can specify different intervals for different commands by changing the socketTimeoutInterval before issuing the command.

As long as the action is still pending, the socketTimeout message is sent every time the socketTimeoutInterval elapses. For example, if the socketTimeoutInterval is 1000 milliseconds (one second), a socketTimeout message is sent every second until the action completes.

Examples

set the socketTimeoutInterval to 100 -- one-tenth of a second

Related

property: script

command: read from socket, write to socket

function: milliseconds

glossary: object, socket, message, command, timeout, execute

keyword: integer

message: socketTimeout

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile